Add new Rails/JSONSymbolizeNames cop
#1534
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viralpraxis
force-pushed
the
add-new-rails-json-symbolize-names-cop
branch
from
5d3d3cd to
d75d110
Compare
|
Could you first propose this style to the style guide? |
koic
reviewed
Oct 10, 2025
koic
reviewed
Oct 10, 2025
| # JSON.parse(json, symbolize_names: true) | ||
| # | ||
| class JSONSymbolizeNames < Base | ||
| MSG = 'Use `symbolize_names` option.' |
There was a problem hiding this comment.
This message only shows the option name, which might make it difficult for users to understand the expected action in their code. It may be simpler to provide autocorrection and show the corrected code instead.
There was a problem hiding this comment.
I've implemented autocorrection
viralpraxis
added a commit
to viralpraxis/rails-style-guide
that referenced
this pull request
Oct 11, 2025
…ep_symbolize_keys` ref: rubocop/rubocop-rails#1534
viralpraxis
force-pushed
the
add-new-rails-json-symbolize-names-cop
branch
2 times, most recently
from
fb6b1c1 to
62d7df0
Compare
From the issue:
So seems like this cop is acceptable, could you please take a look? @koic |
viralpraxis
force-pushed
the
add-new-rails-json-symbolize-names-cop
branch
from
62d7df0 to
5622ae7
Compare
viralpraxis
force-pushed
the
add-new-rails-json-symbolize-names-cop
branch
from
5622ae7 to
19e40c1
Compare
I've seen this pattern a lot: ```ruby JSON.parse(large_json).deep_symbolize_keys ``` instead of travesing Ruby hash once more we can use the `symbolize_names` option: ```ruby JSON.parse(large_json, symbolize_names: true) ``` Caveats / FP scenarios: 1. `symbolize_names` does not work if `create_addition` option is provided. 2. User might use both `symbolize_names: false` and `deep_symbolize_keys`. 3. There's no autocorrection yet, but it should be easy to add.
viralpraxis
force-pushed
the
add-new-rails-json-symbolize-names-cop
branch
from
19e40c1 to
750fbc7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've seen this pattern a lot:
instead of travesing Ruby hash once more we can use the
symbolize_namesoption:Caveats / FP scenarios:
symbolize_namesdoes not work ifcreate_additionoption is provided.symbolize_names: falseanddeep_symbolize_keys.Before submitting the PR make sure the following are checked:
master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.